[Docs] [6/N] Refactor Readme: Streamline README and move setup/trace details to other places#2652
[Docs] [6/N] Refactor Readme: Streamline README and move setup/trace details to other places#2652ykwd wants to merge 9 commits into
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Code Review
This pull request updates the documentation across several files, including the main README, the FAST'25 release notes, and the quick-start guide. The updates provide a clearer overview of Mooncake's architecture, simplify the installation instructions for different hardware backends, introduce new KV cache analysis tools, and update the citation section. The review comments suggest minor grammatical and formatting improvements, such as correcting the phrasing of an open-source link and fixing a spacing issue alongside a relative link path. Both comments are valid and should be addressed.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
37b3834 to
9d470ed
Compare
Summary
This PR streamlines the root
README.mdand moves detailed setup and trace content into the documentation site andFAST25-release/, so the README stays a concise entry point while full guides remain easy to find.Motivation
The root README had grown long, with setup details duplicated between the README and the docs. This change:
FAST25-release/.PR Content
README improvements
pip installcommands; link to the docs for prerequisites, source builds, deployment, and other accelerator backends.<details>block to reduce visual clutter.FAST25-release/README.md; summarize traces in the README and link toFAST25-release, plus the KV Cache Size Calculator and Hit Rate Simulator tools.Documentation sync
docs/source/getting_started/quick-start.md.New file
FAST25-release/README.mdwith trace sample format and release notes (content previously inline in the root README).Changes
README.mddocs/source/getting_started/quick-start.mdFAST25-release/README.md